appcompat/androidx.appcompat.widget/[main]SearchView

SearchView

open class SearchView : LinearLayoutCompat, CollapsibleActionView(source)

(SESL variant) A widget that provides a user interface for the user to enter a search query and submit a request to a search provider. Shows a list of query suggestions or results, if available, and allows the user to pick a suggestion or result to launch into.

When the SearchView is used in an ActionBar as an action view, it's collapsed by default, so you must provide an icon for the action.

If you want the search field to always be visible, then call setIconifiedByDefault(false).

Constructors

SearchView

constructor(@NonNull context: @NonNull Context)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, defStyleAttr: Int)

Types

OnCloseListener

interface OnCloseListener

OnPrivateImeCommandListener

interface OnPrivateImeCommandListener

OnQueryTextListener

interface OnQueryTextListener

Callbacks for changes to the query text.

OnSuggestionListener

interface OnSuggestionListener

Callback interface for selection events on suggestions.

SearchAutoComplete

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open class SearchAutoComplete : AppCompatAutoCompleteTextView

Local subclass for AutoCompleteTextView.

Functions

clearFocus

open fun clearFocus()

getImeOptions

open fun getImeOptions(): Int

Returns the IME options set on the query text field.

getInputType

open fun getInputType(): Int

Returns the input type set on the query text field.

getMaxWidth

open fun getMaxWidth(): Int

Gets the specified maximum width in pixels, if set.

getQuery

open fun getQuery(): CharSequence

Returns the query string currently in the text field.

getQueryHint

@Nullable

open fun getQueryHint(): @Nullable CharSequence

Returns the hint text that will be displayed in the query text field.

getSuggestionsAdapter

open fun getSuggestionsAdapter(): CursorAdapter

Returns the adapter used for suggestions, if any.

isIconfiedByDefault

open fun isIconfiedByDefault(): Boolean

Returns the default iconified state of the search field.

isIconified

open fun isIconified(): Boolean

Returns the current iconified state of the SearchView.

isQueryRefinementEnabled

open fun isQueryRefinementEnabled(): Boolean

Returns whether query refinement is enabled for all items or only specific ones.

isSubmitButtonEnabled

open fun isSubmitButtonEnabled(): Boolean

Returns whether the submit button is enabled when necessary or never displayed.

onActionViewCollapsed

open fun onActionViewCollapsed()

Called when this view is collapsed as an action view.

onActionViewExpanded

open fun onActionViewExpanded()

Called when this view is expanded as an action view.

onWindowFocusChanged

open fun onWindowFocusChanged(hasWindowFocus: Boolean)

performLongClick

open fun performLongClick(): Boolean

requestFocus

open fun requestFocus(direction: Int, previouslyFocusedRect: Rect): Boolean

seslGetAutoCompleteView

open fun seslGetAutoCompleteView(): AutoCompleteTextView

seslGetOverflowMenuButton

open fun seslGetOverflowMenuButton(): ImageView

seslGetUpButton

open fun seslGetUpButton(): ImageView

seslIsSviEnabled

open fun seslIsSviEnabled(): Boolean

seslSetNotCallShowSoftInput

open fun seslSetNotCallShowSoftInput(notCall: Boolean)

seslSetOnOverflowMenuButtonClickListener

open fun seslSetOnOverflowMenuButtonClickListener(listener: View.OnClickListener)

seslSetOnPrivateImeCommandListener

open fun seslSetOnPrivateImeCommandListener(@Nullable listener: @Nullable SearchView.OnPrivateImeCommandListener)

seslSetOnUpButtonClickListener

open fun seslSetOnUpButtonClickListener(listener: View.OnClickListener)

seslSetOverflowMenuButtonIcon

open fun seslSetOverflowMenuButtonIcon(drawable: Drawable)

seslSetOverflowMenuButtonVisibility

open fun seslSetOverflowMenuButtonVisibility(visibility: Int)

seslSetSviEnabled

open fun seslSetSviEnabled(enabled: Boolean): Boolean

seslSetUpButtonIcon

open fun seslSetUpButtonIcon(drawable: Drawable)

seslSetUpButtonVisibility

open fun seslSetUpButtonVisibility(visibility: Int)

setAppSearchData

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setAppSearchData(appSearchData: Bundle)

Sets the APP_DATA for legacy SearchDialog use.

setBackground

open fun setBackground(background: Drawable)

setBackgroundResource

open fun setBackgroundResource(resid: Int)

setElevation

open fun setElevation(elevation: Float)

setIconified

open fun setIconified(iconify: Boolean)

Iconifies or expands the SearchView.

setIconifiedByDefault

open fun setIconifiedByDefault(iconified: Boolean)

Sets the default or resting state of the search field.

setImeOptions

open fun setImeOptions(imeOptions: Int)

Sets the IME options on the query text field.

setInputType

open fun setInputType(inputType: Int)

Sets the input type on the query text field.

setMaxWidth

open fun setMaxWidth(maxpixels: Int)

Makes the view at most this many pixels wide maxWidth

setOnCloseListener

open fun setOnCloseListener(listener: SearchView.OnCloseListener)

Sets a listener to inform when the user closes the SearchView.

setOnQueryTextFocusChangeListener

open fun setOnQueryTextFocusChangeListener(listener: View.OnFocusChangeListener)

Sets a listener to inform when the focus of the query text field changes.

setOnQueryTextListener

open fun setOnQueryTextListener(listener: SearchView.OnQueryTextListener)

Sets a listener for user actions within the SearchView.

setOnSearchClickListener

open fun setOnSearchClickListener(listener: View.OnClickListener)

Sets a listener to inform when the search button is pressed.

setOnSuggestionListener

open fun setOnSuggestionListener(listener: SearchView.OnSuggestionListener)

Sets a listener to inform when a suggestion is focused or clicked.

setQuery

open fun setQuery(query: CharSequence, submit: Boolean)

Sets a query string in the text field and optionally submits the query as well.

setQueryHint

open fun setQueryHint(@Nullable hint: @Nullable CharSequence)

Sets the hint text to display in the query text field.

setQueryRefinementEnabled

open fun setQueryRefinementEnabled(enable: Boolean)

Specifies if a query refinement button should be displayed alongside each suggestion or if it should depend on the flags set in the individual items retrieved from the suggestions provider.

setSearchableInfo

open fun setSearchableInfo(searchable: SearchableInfo)

Sets the SearchableInfo for this SearchView.

setSubmitButtonEnabled

open fun setSubmitButtonEnabled(enabled: Boolean)

Enables showing a submit button when the query is non-empty.

setSuggestionsAdapter

open fun setSuggestionsAdapter(adapter: CursorAdapter)

You can set a custom adapter if you wish.

SearchView

See also

Constructors

Types

Functions